feat: whitelist packages on check-licenses action #600
Conversation
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
github-actions
bot
added
the
enhancement
| @@ -182,9 +190,10 @@ runs: | |||
| retention-days: 7 | |||
|
|
|||
| - name: Check library's dependencies license | |||
| uses: ansys/actions/check-licenses@main | |||
| uses: ansys/actions/check-licenses@feat/whitelist-packages | |||
There was a problem hiding this comment.
Should be reverted to main once approved and before merging
| uses: ansys/actions/check-licenses@feat/whitelist-packages | |
| uses: ansys/actions/check-licenses@main |
| shell: bash | ||
| run: | | ||
| if [[ -n "${{ inputs.whitelist-license-check }}" ]]; then | ||
| echo "Whitelisted packages: ${{ inputs.whitelist-license-check }}" |
There was a problem hiding this comment.
Maybe we could echo the path of the "ignored-packages.txt" so we can easily access the list.
Also at the top of this file, I will explain why the following packages are for.
There was a problem hiding this comment.
The content of the ignored-packages.txt file is printed out: see https://github.com/ansys/pyansys-tools-report/actions/runs/11177206820/job/31072221914?pr=219#step:2:829 as an example
The reasons why we are ignoring some of them is already explained in the description I think but we can improve it if you want... what do you have in mind?
See
actions/check-licenses/action.yml
Lines 26 to 66 in 0065b8b
There was a problem hiding this comment.
Just put the content of the description.
It is just for users that could find the file without knowing about the existence of the action.
Some contributors might see this file without knowing what is its intent because they don't know about all the actions we have.
There was a problem hiding this comment.
I like this approach, the one that I had in mind was to allow licenses instead of packages but I think I prefer your approach.
Following @MaxJPRey, it would be great if extra ignored packages could be logged so that you can easily see them if you ever look at the logs. That's a nice way to remember that you ignored packages from the license checker.
Closes #516
Testing done in ansys/pyansys-tools-report#219